home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Workbench Design
/
WB Collection.iso
/
workbench werkzeuge
/
bildschirmschoner
/
auror15a
/
aurora_15a.doc
< prev
next >
Wrap
Text File
|
1996-04-07
|
45KB
|
1,286 lines
IT IS ILLEGAL TO MAKE UNAUTHORIZED COPIES OF THIS SOFTWARE
This software is protected under federal copyright law. It is
illegal to make or distribute copies of this software except to
make a backup for archival purposes only. Duplication of this
software for any other reason including for sale, loan, rental,
or gift is a federal crime. Penalties include fines as high as
$50,000 and jail terms of up to five years.
COPYRIGHT NOTICE
This manual and the software described in this manual are
copyrighted. All rights reserved. No part of this documentation
or described software may be copied, reproduced, translated, or
reduced to any machine-readable form without the prior written
consent of Inline Services, P.O. Box 3204, Hampton, VA
23663-0204.
The demonstration version of this software is freely
distributable via normal public domain channels so long as the
archive is in its original form as provided by Inline Services,
and no charges are incurred by the user. You are prohibited from
seperating, altering, or using any file not contained within the
"Freeware" directory of said original archive for any purpose
other than demonstration of Aurora. The demonstration version
has it's Arexx port disabled, limiting users to their "default
ModeID", and the F10 key will not save the current screen.
* Amiga is a registered trademark of Amiga Technologies.
* OpalVision is a registered trademark of Centaur Development.
* Art Department Professional is a registered trademark of ASDG.
Installer and Installer project icon (c) Copyright 1991-93
Commodore-Amiga, Inc. All Rights Reserved. Reproduced and
distributed under license from Commodore.
INSTALLER SOFTWARE IS PROVIDED "AS-IS" AND SUBJECT TO CHANGE; NO
WARRANTIES ARE MADE. ALL USE IS AT YOUR OWN RISK. NO LIABILITY
OR RESPONSIBILITY IS ASSUMED.
Aurora v1.5 and above provides support for ptreplay.library v5.14
by Mattias Karlsson. This library is freeware and is provided
with Aurora for completeness. PTReplay.library is NOT required
for Aurora MOD file playback. No additional cost has been added
due to its use or inclusion.
PTReplay.library version 5.14 by Mattias Karlsson. 1995
BetaSoft. This version is freeware. You may use this library,
and also copy it further, provided that NO CHARGE is claimed.
This message must always accompany any files in the
PTReplay.library that are distributed.
Introduction to Aurora . . . . . . . . . . . . . . . . . . . . 1
Aurora System Requirements . . . . . . . . . . . . . . . . . . 1
Installing Aurora . . . . . . . . . . . . . . . . . . . . . . . 1
Aurora Preference Editor . . . . . . . . . . . . . . . . . . . 3
Switches Section . . . . . . . . . . . . . . . . . . . . . 3
Preference Editor Hotkey Section . . . . . . . . . . . . . 3
Password Protection Section . . . . . . . . . . . . . . . 4
Driver Selection . . . . . . . . . . . . . . . . . . . . . 4
Module Selection . . . . . . . . . . . . . . . . . . . . . 4
Unblanking Input Events Section . . . . . . . . . . . . . 4
Miscellaneous Gadgets . . . . . . . . . . . . . . . . . . 5
Aurora Variable Editor . . . . . . . . . . . . . . . . . . . . 6
Random Module Configuration . . . . . . . . . . . . . . . . . . 8
Aurora/Commodities Exchange Interface . . . . . . . . . . . . . 9
Aurora Display Driver Capabilities . . . . . . . . . . . . . . 10
Aurora Module Descriptions . . . . . . . . . . . . . . . . . . 11
Common Information . . . . . . . . . . . . . . . . . . . . 11
Arexx Module . . . . . . . . . . . . . . . . . . . . . . . 11
Aswarm Module . . . . . . . . . . . . . . . . . . . . . . 12
Clock Module . . . . . . . . . . . . . . . . . . . . . . . 12
Cycle Module . . . . . . . . . . . . . . . . . . . . . . . 12
Julia Module . . . . . . . . . . . . . . . . . . . . . . . 12
JuliaFP Module . . . . . . . . . . . . . . . . . . . . . . 13
Lines Module . . . . . . . . . . . . . . . . . . . . . . . 13
Mandelbrot Module . . . . . . . . . . . . . . . . . . . . 13
MandelbrotFP Module . . . . . . . . . . . . . . . . . . . 13
Marquee Module . . . . . . . . . . . . . . . . . . . . . . 14
Mystic Module . . . . . . . . . . . . . . . . . . . . . . 14
Null Module . . . . . . . . . . . . . . . . . . . . . . . 14
Plasma Module . . . . . . . . . . . . . . . . . . . . . . 15
Puzzle Module . . . . . . . . . . . . . . . . . . . . . . 15
Raindrops Module . . . . . . . . . . . . . . . . . . . . . 15
Random Module . . . . . . . . . . . . . . . . . . . . . . 15
SlideShow Module . . . . . . . . . . . . . . . . . . . . . 15
Squares Module . . . . . . . . . . . . . . . . . . . . . . 15
Starfield Module . . . . . . . . . . . . . . . . . . . . . 16
Aurora Arexx Interface Information . . . . . . . . . . . . . . 17
MODULE Command . . . . . . . . . . . . . . . . . . . . . . 17
DRIVER Command . . . . . . . . . . . . . . . . . . . . . . 17
TIME Command . . . . . . . . . . . . . . . . . . . . . . . 17
MOUSETIME Command . . . . . . . . . . . . . . . . . . . . 17
OSCAN Command . . . . . . . . . . . . . . . . . . . . . . 17
i
MODEID Command . . . . . . . . . . . . . . . . . . . . . . 17
MODULEMODEID Command . . . . . . . . . . . . . . . . . . . 17
WINDOW Command . . . . . . . . . . . . . . . . . . . . . . 18
VARx Command . . . . . . . . . . . . . . . . . . . . . . . 18
STRx Command . . . . . . . . . . . . . . . . . . . . . . . 18
HANGUP Command . . . . . . . . . . . . . . . . . . . . . . 18
UNBLANK Command . . . . . . . . . . . . . . . . . . . . . 18
QUIT Command . . . . . . . . . . . . . . . . . . . . . . . 18
RANDOMTIME Command . . . . . . . . . . . . . . . . . . . . 18
SOUND Command . . . . . . . . . . . . . . . . . . . . . . 19
STARTCMD Command . . . . . . . . . . . . . . . . . . . . . 19
STOPCMD Command . . . . . . . . . . . . . . . . . . . . . 19
Common ModeID Values for WB2.x Users . . . . . . . . . . . . . 20
ii
Introduction to Aurora
Aurora is a modular screen saver utility. Some of its major
features include:
* Modular screen blanking routines that provide easy updates and
expansion.
* System friendly mouse blanker with congifurable time setting.
* Display driver libraries supporting all Amiga 16/32/256 color
screenmodes and the OpalVision video card.
* Registers as a system commodity.
* Each module is capable of unique numeric and string variable
definitions, screen resolution, music file, and start/stop
commands.
* Module variable editor which creates Arexx scripts with your
module preferences.
* Complete Arexx interface for easy system control.
* Optional Workbench status window.
* qRandom module capable of periodically reselecting another
module.
* Screen resolutions can be from any installed monitor.
* Eight user selectable unblanking events.
* System password protection.
* Complete support for WorkBench 3.x datatypes.
Aurora is provided with 14 graphics modules, an Arexx
interface/script execution module, and a random selection module.
Aurora System Requirements
Aurora requires Amiga KickStart v2.04 or above, one megabyte
of chip ram, a 68000 or better processor, and one of the
following display devices:
* Any Amiga non-HAM/non-EHB display.
* OpalVision video card.
* Picasso II or any other graphics card capable of selecting
it's screenmode through an operating system compliant monitor
type.
Two megabytes of chip ram, any amount of fast ram, and a
68020+ processor are highly recommended.
Aurora runs from either Workbench or the CLI. To use Aurora's
module variable capabilities, you must have RexxMast running.
This is included with the Amiga system software.
Installing Aurora
To install Aurora double click the install icon. You will be
presented with Amiga Technologies' standard installation program.
You need to select a path where an Aurora directory will be
created, a default image loading path, and which modules the
1
random module will use in its selection process. After the files
have been copied into the new directory, an Aurora icon will be
placed in your SYS:WBStartup directory. This is the most
convenient method of running Aurora. During the installation,
you will be asked if you want your S:User-Startup file altered to
include an Aurora: assignment. This is required for Aurora to
work properly.
Aurora will run automatically after the installation process
is complete, and the Preference Editor screen will open to allow
you to configure your default settings.
2
Aurora Preference Editor
Aurora's Preference Editor allows you to modify all of
Aurora's options via an intuition interface.
Switches Section
The Switches section allows you to define the default screen
resolution that all modules will use. This is accomplished via
the HIRES, LACED, OSCAN and Default ModeID gadgets. These
resolution settings will apply only if you have not edited a
specific module's variable preferences. The WINDOW gadget
enables or disables Aurora's WorkBench status window.
Preference Editor Hotkey Section
This section allows you to define the hotkey sequence that
invokes the Preference Editor. Select the key and qualifiers
that you want to use (you'll see by default they have 'L-ALT',
'CTRL', and KEY='A' selected). You can choose ANY combination of
Left Alt, Right Alt, Left Shift, Right Shift, and Ctrl keys. The
'KEY' selection can be any keypress that can be entered into this
gadget. The keys selected must all be pressed simultaneously to
invoke the Preference Editor. If you find that Aurora conflicts
3
with another program supporting hotkeys, you will need to change
either Aurora's or the conflicting program's hotkey definitions.
Password Protection Section
The gadgets under the 'Password Protection' label enable or
disable the protection feature. If 'LOCK' is enabled, the string
gadget to it's right allows entry of your password. Up to ten
characters can be entered and the password is case sensitive. If
the password protection feature is enabled, you will be asked for
it any time you run Aurora, whenever the Preference Editor is
invoked and after a module has unblanked.
Driver Selection
The listview gadget under the Display section allows you to
select from any of the supported display drivers. The selected
driver name will be highlighted. If the selected driver is
invalid on your system (IE Selecting the OpalVision driver on a
system that does not have an OpalVision), you will be notified of
this, and the driver will be deselected.
Each driver can have it's own default image directory. To
edit this setting, double click on the driver name. A small
window with standard Aurora file selection gadgets will open and
allow you to specify the directory you wish to use. This enables
different drivers to use images that perhaps only it can load.
A display driver MUST be selected to exit the Preference
Editor and/or to edit any module preference settings.
Module Selection
The gadgets under the 'Module' label allow selection of the
desired blanking module and the task priority of the module while
it is running.
The listview gadget contains the names of all modules
contained in the 'Aurora:Modules/' directory. Click on the name
of the module you want to use. The selected module name will be
highlighted. If you want to edit a specific module's variable
settings, double click on it's name. This will invoke the module
variable editor. Double clicking on the Random module will open
the Random Module Configuration window. A module MUST be
selected to exit the Preference Editor.
Unblanking Input Events Section
This section allows you to specify which input events will
cause Aurora to unblank. 'Mouse Movement', 'Left Button', and
'Right Button' are all mouse related input events. The
'Keypress', 'Disk Insertion', and 'Disk Removal' are
self-explanatory. The 'Serial Carrier' and 'Serial Ring' gadgets
allow you to treat these serial.device events as input events.
If either or both of the carrier or ring events are selected, the
device and unit as indicated by the cycle and device filename
gadgets will be opened in shared mode. This may require you to
alter your preferences in other applications that also use the
selected device. On some Amigas the printer ready signal from
4
the parallel port and the serial ring signal from the serial port
interfer with each other. If you select the Serial Ring event
and Aurora does not blank, try turning your printer on or off
(depending on the printer's state when the problem existed).
You can select any combination of input events, but at least
one must remain selected. If you exit the Preference Editor
without any input events selected, Aurora will default to all
events enabled. These input events are for unblanking purposes
only. All possible input events are monitored while Aurora is
not blanked and will prevent Aurora from blanking if they are
detected.
Miscellaneous Gadgets
The 'Screen Blanker Inactivity Period' slider determines the
number of seconds before screen blanking occurs. The slider's
range is from 10-600 seconds (10 minutes).
The 'Mouse Blanker Inactivity Period' slider determines the
number of seconds before mouse blanking occurs. The slider's
range is from 0-60 seconds. Setting the slider to 0 disables the
mouse blanking feature.
The 'Save' button saves your preferences to the ENVARC: and
ENV: directories and they will be valid after any reboot. The
'Use' button saves your preferences only to the ENV: directory,
so if you reboot, you'll need to reselect preferences or the
previously saved preferences will be used. The 'Cancel' button
does just that, cancels without any saves.
5
Aurora Variable Editor
You enter the Variable Editor by double-clicking a module name
in the Preference Editor's "Modules" list gadget. This queries
the module and provides a listing of all supported variables and
their descriptions. It also displays authoring information and
any miscellaneous information pertinent to the module.
Each numeric variable will have a corresponding slider gadget.
Each string variable will have a corresponding string gadget and
possibly a '?' (AslRequester) gadget if the variable is intended
as a filename. Each gadget is labeled with "VARx" or "STRx".
These labels correspond to the Arexx keyword used to alter that
variable. If a variable is not supported by the module, you will
not get a gadget for it.
The 'HIRES', 'LACED', and 'OSCAN' gadgets allow you to specify
custom screen resolutions for the module displayed in the
Variable Editor. The MODEID gadget and associated '?' gadget
allow WB3.+ users to select the desired screenmode from the Asl
Screenmode Requester. These settings override the global
resolution defined with the Preference Editor.
The "MOD Music" gadget and corresponding "?" allow you to
6
select a Protracker music module to play while the module is
active.
The "Start Cmd" and "Exit Cmd" gadgets allow you to specify
AmigaDOS commands, scripts, or Arexx scripts to execute when the
module first blanks and after the module has unblanked. These
can be used for any purpose and have been included for
flexibility. Something to note is that Aurora automatically
performs an "Avail Flush" command after each module unblanks just
for general housekeeping.
At the bottom of the Variable Editor window are four
additional gadgets. The 'Save' gadget generates an Arexx script
in your 'Aurora:Rexx/' directory for the module, based on the
slider, string, and screen resolution gadgets. The 'Cancel'
gadget will return you to the Preference Editor window, ignoring
any changes made while in the Variable Editor. The 'Defaults'
gadget initializes the slider and string gadgets to the default
values contained in the module. The 'Test' gadget launches the
selected module with the current variable and screen resolution
settings. This allows you to instantaneously see how the module
will perform.
7
Random Module Configuration
The Random Module Configuration window allows you to configure
all the options used by the Random module.
The window is subdivided into two sections. The first section,
called "Module Selections", allows simple selection of which
modules can be picked by the Random module. If you want a module
to be used in the random selection, click the box next to its
name. Only the modules with check-marked boxes will be used in
the selection.
The second section, called "Miscellaneous Settings" allows you
to specify the "Auto Change Period" and the overall default image
directory.
The Auto Change Period is the amount of time each module is
ran before a new random module is selected. In the figure above,
you will see it is set to 0 hours and 15 minutes. With these
settings, after each 15 minute time frame, the currently running
module will unblank, and a new one will be started. The Auto
Change Period is configurable from 0 hours 0 minutes to 23 hours
59 minutes. By setting both sliders to 0, the Auto Change
feature is disabled.
8
The Overall Default Image Directory is used by Aurora to find
loadable image formats for any module that requires an image (EG
Slideshow, Puzzle, Cycle). Each display driver is capable of
having it's own default image directory, but in the event you
have not configured a selected driver or no loadable images are
contained within the directory you have selected, the overall
image directory will be used.
Aurora/Commodities Exchange Interface
Aurora registers itself with the Commodities Exchange at
start-up.
The Commodities Exchange ACTIVE/INACTIVE gadget respectively
enables or disables Aurora's blanking timer. The WorkBench
status window will continue to update while Aurora is INACTIVE,
however Aurora will not enter it's screen or mouse blanking
routines.
The Commodities Exchange REMOVE gadget will cause Aurora to
free all it's resources and exit.
You may also invoke and exit the Preference Editor through the
Commodities Exchange SHOW INTERFACE and HIDE INTERFACE gadgets.
9
Aurora Display Driver Capabilities
The Amiga_ECS display driver requires KickStart 2.04 or above.
It is capable of using any Amiga screen with the exceptions of
HAM and Extra Halfbright displays.. The maximum number of colors
used depends on the screen resolution. Hires screens use 16
colors and Lores screens use 32 colors. Amiga AGA and Picasso II
users can open any screen with 256 colors using this driver. The
color accuracy of this driver is 16 levels per Red, Green, and
Blue pens for a total palette of 4,096 colors. The
Amiga_ECS/WorkBench 2.x combination is capable of loading ONLY
IFF formated images. The Amiga_ECS/WorkBench 3.x combination
uses datatypes to load images. It can therefore load any image
format that you have a datatype for.
The Amiga_AGA display driver requires KickStart 3.0 or above.
Amiga_AGA is identical to the Amiga_ECS driver except for the
color accuracy. The Amiga_AGA driver is accurate to 256 levels
per Red, Green, and Blue pens for a total palette of 16,277,216
colors. The Amiga_AGA display driver uses datatypes to load
images. It can therefore load any image format that you have a
datatype for. Picasso II users should select this driver if
running under WorkBench 3.0 or above.
The OpalVision display driver requires KickStart 2.04 or
above, an OpalVision display card, and any version of
opal.library. OpalVision always uses a 256 color screen at one
of the following resolutions:
Display Std Oscan
Lores 320x200 384x236
LoresLaced 320x400 384x476
Hires 640x200 768x236
HiresLaced 640x400 768x476
PAL resolutions are also used if you specify a PAL ModeID.
The OpalVision driver is capable of loading any image format
supported by the OpalVision library and the OpalVision
Loader/Saver Interface standard.
For Workbench 3.x users, Aurora comes with an OpalVision
datatypes.loader that will allow Aurora and all other OpalVision
applications (OpalPaint, OpalPresents!, etc) to load any image
format that you have a datatype for. This loader requires the
commercial version of Aurora to completely load a datatypes
image.
10
Aurora Module Descriptions
The following sections describe each module provided with
Aurora, the variables they support, and the general way each
module operates.
Common Information
Several of the modules support a variable called "Color
Increment/Decrement". The color increment/decrement value is a
number from zero to seven. Think of it as how fast colors will
change on screen. A color increment value of zero means the
color will increment by one, giving a very gradual color shift.
A value of three will increment the color by eight, so the shift
becomes faster. It also reduces the number of possible colors
per pen. Instead of 256 levels each of red, green, and blue, you
only have (256/8) or 32 levels. The following table gives the
variable values, increment amount, and total colors possible for
each variable value:
OpalVision/Amiga_AGA
Value Increment Total Colors
0 1 256 out of 16,777,216
1 2 256 out of 2,097,152
2 4 256 out of 262,144
3 8 256 out of 32,768
4 16 256 out of 4,096
5 32 256 out of 512
6 64 64 out of 64
7 128 8 out of 8
Amiga_ECS (LoRes Screen)
Value Increment Total Colors
0 1 32 out of 4,096
1 2 32 out of 4,096
2 4 32 out of 4,096
3 8 32 out of 4,096
4 16 32 out of 4,096
5 32 32 out of 512
6 64 32 out of 64
7 128 8 out of 8
All palette files provided with Aurora contain a 256 color
'CMAP' IFF chunk and were generated using Art Department
Professionals' Palette Editor.
All modules support saving the blanking screen as an IFF
image. This can be accomplished by pressing F10 while Aurora is
blanked. The F10 key is valid only while Aurora is blanked. The
IFF images will be saved in the Aurora:IFF/ directory as
sequentially numbered files starting with "AuroraIFF.0001".
Arexx Module
The Arexx module enables Arexx scripts to be used as blanking
11
routines. It creates the host name of 'Arexx_Module' and
supports two commands.
The 'QUERY' command informs the script of Aurora's status. A
result code of 0 means that no input activity has been detected
and you can continue with your script's execution. A result code
of 5 means that Aurora needs to unblank, so exit your script and
return control.
The 'QUIT' command informs the Arexx module that you are
exiting and that control may be passed back to Aurora. The
module will wait a user definable number of seconds from the time
Aurora commands it to exit to receive this command. If you
haven't issued the 'QUIT' command and exited your script within
this time frame, the module will exit anyway. This will result
in your Arexx script getting an "Invalid function host" error the
next time it tries to find the "Arexx_Module" port.
If you intend to write Arexx scripts for this module, you
should issue the 'QUERY' command on a regular basis and follow
the proper route as dictated by the result code.
The Arexx module supports two variables, VAR0 is the time in
seconds the Arexx module will wait for someone to "talk" to it
before shutting down. STR0 is the path/filename of the Arexx
script to execute. There is not a default value for this
variable, so by not specifying a valid script name, the module
will fail (Aurora will unblank immediately).
Aswarm Module
The Aswarm module simulates a group of bees chasing a number
of wasps, while the color of the bees is constantly changed.
The Aswarm module supports four variables. VAR0 is the number
of wasps that will be chased, VAR1 is the number of bees that
will do the chasing, and VAR2 is the tightness of the bee groups.
A higher value of tightness will keep the bees closer together.
STR0 specifies the 256 color palette file to use for bee color
changing. If STR0 is not specified, the default palette
Aurora:IFF/HSV.palette will be used.
Clock Module
The Clock module starts by drawing an analog clock face with
random colors. Each minute the colors are repicked and altered
on screen. The clock contains hour, minute, and second hands.
Cycle Module
The Cycle module starts by loading a color or grayscale image.
It then picks a random color and starts palette cycling to reach
that color.
Cycle supports two variables. VAR0 is the color
increment/decrement value. STR0 is the filename of an IFF
pattern image. If STR0 is left blank, a random image from your
default image directory will be chosen.
Julia Module
12
The Julia module first selects a random point from the
Mandelbrot set and tests its location for color variations. If
the color variations meet certain criteria, a random starting
color is picked and the Julia fractal is generated.
Based on the random coordinate/first color selections, the
number of different Julia images that can be generated is
astronomical.
The variables supported by this module are VAR0 and STR0.
VAR0 is the number of iterations used. The higher the iteration,
the more detailed the image. STR0 is the name of the 256 color
palette file to use. This module uses double precision floating
point math.
JuliaFP Module
The JuliaFP module is identical to the Julia module with the
exceptions of the required processor and the type of math used.
This module requires a 68030 or better processor and a
68881/68882 math coprocessor.
Lines Module
The Lines module draws sequentially positioned lines, with
each line's color offset from the previous one. This module
supports three variables. VAR0 is the number of line sets, VAR1
is the number of lines per set, and VAR2 is the color
increment/decrement value.
Each line is allocated it's own palette entry, which allows
one line per screen color, less one, at any given time (palette
entry 0 is used for the black background). The number of sets
times the number of lines must be less than the number of screen
colors.
Mandelbrot Module
The Mandelbrot module first selects a window size based on the
full width/height of the MandelBrot set, divided by a random zoom
level. It then selects a random area for the window and tests
its perimeters for color variations. If the color variations
meet certain criteria, a random starting color is picked and the
mandelbrot is generated.
Based on the random coordinate/zoom level/first color
selections, the number of different mandelbrot images that can be
generated is astronomical.
The variables supported by this module are VAR0 and STR0.
VAR0 is the number of iterations used. The more iterations, the
more detailed the image. STR0 is the name of the 256 color
palette file to use. This module uses double precision floating
point math.
MandelbrotFP Module
The MandelbrotFP module is identical to the Mandelbrot Module
with the exceptions of the required processor and the type of
math used. This module requires a 68030 or better processor and
a 68881/68882 math coprocessor.
13
Marquee Module
The Aurora Marquee module uses a two color native Amiga screen
(THIS MODULE DOES NOT USE THE SELECTED DISPLAY DRIVER!) with the
resolution specified by the Variable Editor. This module
supports three numeric variables and two string variables.
Marquee renders and scrolls user specified text horizontally
across a black screen, randomly changing the text color and
vertical position with each pass.
VAR0 is the font vertical size in pixels. Depending on your
screen resolution and font size, the font might not fit the
screen. In this event, a default font size of 1/5 screen height
will be used.
VAR1 is the font style sum. The following table lists all 7
style sum combinations:
VAR1 Style
0 Normal (defined in actual font)
1 Underlined
2 Bold
3 Underlined and Bold
4 Italic
5 Italic and Underlined
6 Italic and Bold
7 Italic, Underlined, and Bold
VAR2 is the scrolling speed. This is the horizontal distance
in pixels between each new text rendering.
STR0 is the name of the font to use. This can be any font you
desire, but compugraphic fonts work the best. The default font
is CGTimes which is supplied with the Amiga system software.
STR1 is the text you want rendered. Something to note is that
the longer you make this string, the slower the text will scroll.
Mystic Module
The Aurora Mystic module draws sequentially positioned
triangles with each triangle's color offset from the previous
one. VAR0 is the number of triangle sets, VAR1 is the number of
triangles per set, and VAR2 is the color increment/decrement
value.
Each triangle is allocated it's own palette entry, which
allows the number of screen colors (less one) triangles on screen
at any given time (palette entry 0 is used for the black
background). The number of sets times the number of triangles
must be less than the number of screen colors.
Null Module
The Null module opens a blank black screen, turns copper and
bitplane DMA off, and then goes to sleep. It stays asleep until
Aurora commands it to exit. This module is intended for use when
rendering or other processor intensive tasks are running.
Virtually no CPU resources are expended on Aurora or it's module
14
during this time.
This module writes directly to hardware registers, so future
Amiga model compatibility is questionable.
Plasma Module
The Plasma module generates a plasma fractal image in four
passes, while randomly picking and cycling in new palette colors.
This module supports one variable. VAR0 is the color
increment/decrement value.
Puzzle Module
The Puzzle module loads an image and treats it as a sliding
puzzle. It randomly selects one square out of a grid, clears
that square, and slides one of the four surrounding squares to
fill that gap. This leaves another empty square, it is then
filled, and so on.
This module supports two variables. VAR0 is the number of
horizontal and vertical units in the grid, and STR0 is the image
name (including path) to load. If STR0 is not specified or is an
invalid filename, Aurora will pick one from your default image
directory.
Raindrops Module
The Raindrops module generates random colored ellipses and
rotates the palette to give the appearance of raindrops and their
fading ripples. This module REQUIRES 32 palette entries to
function, so Amiga_ECS users must use a Low Resolution or Low
Resolution Interlaced screen with this module.
Random Module
The Random module is not really a module per se. It selects
one of the other modules for execution. It also ensures each
module is ran at least once before it begins repetitive
selections.
SlideShow Module
The SlideShow module sequentially displays all loadable image
formats in a specified directory. For the OpalVision Display
Driver, loadable formats include IFF, JPEG, and any LSI modules
you may have installed. The Amiga AGA Display Driver loadable
formats are anything you have a datatype for. The Amiga ECS
Display Driver loadable formats are IFF only. It supports two
variables; VAR0 is the delay in seconds between images, and STR0
is the path to your images.
Squares Module
The Squares module draws a square with black borders and moves
it randomly across the screen at varying speeds, leaving the
previous square visible. The color of each square varies from
the previous square by the amount specified through the color
increment/decrement value.
This module supports one variable, VAR0, which is the color
15
increment/decrement.
Starfield Module
The Starfield module generates a 3D starfield effect similar
to those you see in the movies and on TV. The star color is
dependant on its distance from the camera. The further away it
is, the darker it is.
Starfield supports two variables. VAR0 is the maximum number
of stars on screen at any given time, and VAR1 is the speed at
which you are traveling through the field.
16
Aurora Arexx Interface Information
Aurora's Arexx interface supports virtually all of the
Preference Editor options. Aurora's Arexx port is named
"Aurora_Rexx". Do not confuse this Arexx compatibility with the
Arexx module. They are two completely separate entities. This
section deals only with the main Aurora program's Arexx
capabilities.
Aurora scripts should contain the OPTION RESULTS command to
enable RESULT based status/variable querying.
MODULE Command
MODULE <name>
This command sets the module to use for blanking. Sending
MODULE by itself will set RESULT to the current module selection.
DRIVER Command
DRIVER <name>
This command sets the display driver to use. Sending DRIVER
by itself will set RESULT to the current display driver
selection.
TIME Command
TIME <seconds>
This command sets the screen blanker inactivity period.
Specifying a numeric value after the TIME keyword will set the
new time. Sending TIME by itself will set RESULT to the current
screen blanker inactivity period setting.
MOUSETIME Command
MOUSETIME <seconds>
This command sets the mouse blanker inactivity period.
Specifying a numeric value after the MOUSETIME keyword will set
the new time. Sending MOUSETIME by itself will set RESULT to the
current mouse blanker inactivity period setting.
OSCAN Command
OSCAN ON|OFF
This command acts as a toggle for the overscan screen flag.
Specifying OSCAN ON sets the overscan flag, while OSCAN OFF
clears it. Specifying OSCAN by itself will set RESULT based on
the condition of the OSCAN setting, either ON or OFF.
MODEID Command
MODEID 0x00000000
This command sets the display mode ID that Aurora will use for
backdrop screens, and as the default module ModeID if one is not
specified through the MODULEMODEID command. The number specified
must be an eight digit hexadecimal number preceded with '0x'.
MODULEMODEID Command
MODULEMODEID 0x00000000
17
This command sets the display mode ID that the module will use
for its blanking screen. The number specified must be an eight
digit hexadecimal number preceded with '0x'.
WINDOW Command
WINDOW ON|OFF
This command acts as a toggle for the Workbench status window.
Specifying WINDOW ON will open the status window if it is not
already opened. Specifying WINDOW OFF will close the window.
Specifying WINDOW by itself will set RESULT based on the
condition of the WINDOW setting, either ON or OFF.
VARx Command
VARx <value>
This command sets one of five numeric variables. x can equate
to 0 through 4. <value> can be any numeric value. Specifying
VARx by itself will set RESULT to the current value of VARx.
There is no range checking done on Arexx variable settings as
this varies with the module. Any invalid variable value will be
ignored and the module will use its default values.
STRx Command
STRx <string>
This command sets one of five string variables. x can equate
to 0 through 4. <string> can be any alphanumeric text.
Specifying STRx by itself will set RESULT to the current value of
STRx.
HANGUP Command
HANGUP
This command drops the serial ports' DTR signal, forcing a
disconnect on modems supporting DTR. This option is only valid
when the 'Serial Carrier' or 'Serial Ring' events are selected
from the Preference Editor. Not all modems treat the dropping of
DTR the same, please consult your modem manual for additional
information.
UNBLANK Command
UNBLANK
This command causes Aurora to unblank as if you moved the
mouse or pressed a key. If Aurora is not currently blanked this
command has no effect.
QUIT Command
QUIT
This command forces Aurora to unblank, free all of its
resources, and exit.
RANDOMTIME Command
RANDOMTIME <minutes>
This command sets the random module change period. Specifying
a numeric value after the RANDOMTIME keyword will set the new
18
time limit. If you set the time to zero, the random module
change feature will be disabled. Sending RANDOMTIME by itself
will set RESULT to the current random module change period
setting.
SOUND Command
SOUND <filename>
This command sets the path and filename to the Protracker .MOD
file to use during screen blanking. Sending SOUND by itself will
set RESULT to the current .MOD path and filename.
STARTCMD Command
STARTCMD <command>
This command defines the system DOS command to be performed at
the start of a screen blanking cycle. <command> should be the
complete path, filename, and arguments for the desired DOS
command. Sending STARTCMD by itself will set RESULT to the
current start command.
STOPCMD Command
STOPCMD <command>
This command defines the system DOS command to be performed at
the end of a screen blanking cycle. <command> should be the
complete path, filename, and arguments for the desired DOS
command. Sending STOPCMD by itself will set RESULT to the
current stop command.
19
Common ModeID Values for WB2.x Users
The following list gives ModeID values for all screen
resolutions available with the Enhanced Chip Set/OpalVision
combination.
Display Name ModeID
NTSC High Res 00019000
NTSC High Res Laced 00019004
NTSC Low Res 00011000
NTSC Low Res Laced 00011004
PAL High Res 00029000
PAL High Res Laced 00029004
PAL Low Res 00021000
PAL Low Res Laced 00021004
AGA Chipset/OpalVision Display Driver Users - The Default
ModeID under the Preference Editor's "Switches Section" must be
one of the above for the OpalVision screen to synchronize to the
backdropped Amiga screen.
20